Interface WirelessCommon

All Superinterfaces:
IPCObject, Process
All Known Subinterfaces:
WirelessClientProcess, WirelessServerProcess
All Known Implementing Classes:
WirelessClientProcessImpl, WirelessCommonImpl, WirelessServerProcessImpl

public interface WirelessCommon extends Process
Information provided by the PKI file:

    \class WirelessCommon
    
    \brief WirelessCommon handles and manipulates common wireless settings.
    
    \example network().getDevice("PC0").getProcess("WirelessClient")
    
Author:
Auto-generated
  • Method Details

    • getAuthenType

      WirelessAuthenType getAuthenType()
      Information provided by the PKI file:
      
          \brief Returns the authentication type.
          
          \return WirelessAuthenType, the authentication type.
          Authentication types:       eAuthenNull = 0,
          eAuthenWep = 1,
          eAuthenWPA1_PSK = 2,
          eAuthenWPA1_EAP = 3,
          eAuthenWPA2_PSK = 4,
          eAuthenWPA2_EAP = 5,
          eAuthenOpen = 6
          
              
      Returns:
      WirelessAuthenType Returns a WirelessAuthenType
    • setAuthenType

      void setAuthenType(WirelessAuthenType type)
      Parameters:
      type - Takes in a parameter of type
    • setSsid

      void setSsid(String ssid)
      Information provided by the PKI file:
      
          \brief Sets the SSID.
          
          \param ssid, the SSID.
          
              
      Parameters:
      ssid - Takes in a parameter of ssid
    • getSsid

      String getSsid()
      Information provided by the PKI file:
      
          \brief Returns the SSID.
          
          \return string, the SSID.
          
              
      Returns:
      String Returns a String
    • getNetworkType

      WirelessNetworkType getNetworkType()
      Information provided by the PKI file:
      
          \brief Returns the network type.
          
          \return WirelessNetworkType,        the network type.
          Network types:      eWirelessDisabled = 0x0,
          eWirelessB = 0x1,
          eWirelessG = 0x2,
          eWirelessBGMixed = 0x3,
          eWirelessN = 0x4,
          eWirelessA = 0x5,
          eWirelessMixed = 0x7
          
              
      Returns:
      WirelessNetworkType Returns a WirelessNetworkType
    • setNetworkType

      void setNetworkType(WirelessNetworkType type)
      Parameters:
      type - Takes in a parameter of type
    • setPort

      boolean setPort(String portName)
      Information provided by the PKI file:
      
          \brief Sets the wireless port with the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
              
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • getPort

      Port getPort()
      Information provided by the PKI file:
      
          \brief Returns the wireless port.
          
          \return Port, the Port object.
          
              
      Returns:
      Port Returns a Port
    • getWepProcess

      WEPProcess getWepProcess()
      Information provided by the PKI file:
      
          \brief Returns the WEP process.
          
          \return WEPProcess, the WEPProcess object.
          
              
      Returns:
      WEPProcess Returns a WEPProcess
    • resetAllAssociations

      void resetAllAssociations()
      Information provided by the PKI file:
      
          \brief Resets all wireless associations.
          
              
    • getEncryptType

      WirelessEncryptType getEncryptType()
      Information provided by the PKI file:
      
          \brief Get encryption type
          \return WirelessEncryptType,                eEncryptNull = 0,
          eEncryptWep_64bit = 1,
          eEncryptWep_128bit = 2,
          eEncryptTKIP = 3,
          eEncryptAES = 4
          
              
      Returns:
      WirelessEncryptType Returns a WirelessEncryptType
    • setEncryptType

      void setEncryptType(WirelessEncryptType type)
      Information provided by the PKI file:
      
          \brief Set encryption type
          \para type, WirelessEncryptType             eEncryptNull = 0,
          eEncryptWep_64bit = 1,
          eEncryptWep_128bit = 2,
          eEncryptTKIP = 3,
          eEncryptAES = 4
          \return none
          
              
      Parameters:
      type - Takes in a parameter of type
    • setStandardChannel

      void setStandardChannel(StandardChannel channel)
      Information provided by the PKI file:
      
          \brief Set standard channel
          \para type, StandardChannel
          eStandardChannel_1 = 0,
          eStandardChannel_2 = 1,
          eStandardChannel_3 = 2,
          eStandardChannel_4 = 3,
          eStandardChannel_5 = 4,
          eStandardChannel_6 = 5,
          eStandardChannel_7 = 6,
          eStandardChannel_8 = 7,
          eStandardChannel_9 = 8,
          eStandardChannel_10 = 9,
          eStandardChannel_11 = 10
          \return none
          
              
      Parameters:
      channel - Takes in a parameter of channel
    • getStandardChannel

      StandardChannel getStandardChannel()
      Information provided by the PKI file:
      
          \brief Get standard channel
          \return StandardChannel
          eStandardChannel_1 = 0,
          eStandardChannel_2 = 1,
          eStandardChannel_3 = 2,
          eStandardChannel_4 = 3,
          eStandardChannel_5 = 4,
          eStandardChannel_6 = 5,
          eStandardChannel_7 = 6,
          eStandardChannel_8 = 7,
          eStandardChannel_9 = 8,
          eStandardChannel_10 = 9,
          eStandardChannel_11 = 10
          
              
      Returns:
      StandardChannel Returns a StandardChannel
    • setWideChannel

      void setWideChannel(WideChannel channel)
      Information provided by the PKI file:
      
          \brief Set wide channel
          \param channel, StandardChannel
          eWideChannel_Auto = 0,
          eWideChannel_3 = 1,
          eWideChannel_4 = 2,
          eWideChannel_5 = 3,
          eWideChannel_6 = 4,
          eWideChannel_7 = 5,
          eWideChannel_8 = 6,
          eWideChannel_9 = 7,
          \return none
          
              
      Parameters:
      channel - Takes in a parameter of channel
    • getWideChannel

      WideChannel getWideChannel()
      Information provided by the PKI file:
      
          \brief Get wide channel
          \return StandardChannel
          eWideChannel_Auto = 0,
          eWideChannel_3 = 1,
          eWideChannel_4 = 2,
          eWideChannel_5 = 3,
          eWideChannel_6 = 4,
          eWideChannel_7 = 5,
          eWideChannel_8 = 6,
          eWideChannel_9 = 7,
          
              
      Returns:
      WideChannel Returns a WideChannel
    • getRadioBand

      WirelessRadioBand getRadioBand()
      Information provided by the PKI file:
      
          \brief Get radio band
          \return WirelessRadioBand
          eRadioAuto = 0,
          eRadioStandard = 1,
          eRadioWide = 2
          
              
      Returns:
      WirelessRadioBand Returns a WirelessRadioBand
    • setRadioBand

      void setRadioBand(WirelessRadioBand radioBand)
      Information provided by the PKI file:
      
          \brief Set radio band
          \param radioBand, WirelessRadioBand
          eRadioAuto = 0,
          eRadioStandard = 1,
          eRadioWide = 2
          
              
      Parameters:
      radioBand - Takes in a parameter of radioBand
    • getWpaProcess

      WPAProcess getWpaProcess()
      Information provided by the PKI file:
      
          \brief Get Wpa Process
          \return WPAProcess, the process that handles and manipulates the WPA encryption process on wireless clients.
          
              
      Returns:
      WPAProcess Returns a WPAProcess